<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>ESP8266_RTOS_SDK: include/espressif/pwm.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ESP8266_RTOS_SDK
   &#160;<span id="projectnumber">v1.4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_cf4dbf1328d2cf10d3f3933741525dc7.html">espressif</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">pwm.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * ESPRSSIF MIT License</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Copyright (c) 2015 &lt;ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * it is free of charge, to any person obtaining a copy of this software and associated</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the Software is furnished</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all copies or</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * substantial portions of the Software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifndef __PWM_H__</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define __PWM_H__</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structpwm__param.html">   48</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structpwm__param.html">pwm_param</a> {</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structpwm__param.html#a3c1ef865ae62e58233701a3bfc68f262">   49</a></span>&#160;    uint32 <a class="code" href="structpwm__param.html#a3c1ef865ae62e58233701a3bfc68f262">period</a>;      </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structpwm__param.html#a8524d98a86c8c4679521ae91d35f6e51">   50</a></span>&#160;    uint32 <a class="code" href="structpwm__param.html#a8524d98a86c8c4679521ae91d35f6e51">freq</a>;        </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structpwm__param.html#a06e6b4fb1983f85d1908d44cb32686a8">   51</a></span>&#160;    uint32 <a class="code" href="structpwm__param.html#a06e6b4fb1983f85d1908d44cb32686a8">duty</a>[8];     </div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;};</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">#define PWM_DEPTH 1023</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__PWM__Driver__APIs.html#ga96286902d138bbba183495583db6f369">pwm_init</a>(uint32 period, uint32 *duty, uint32 pwm_channel_num, uint32(*pin_info_list)[3]);</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__PWM__Driver__APIs.html#ga3c85e3b8654b48f23033f132b91c07b3">pwm_set_duty</a>(uint32 duty, uint8 channel);</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;uint32 <a class="code" href="group__PWM__Driver__APIs.html#gaa2c27474ef8774f6a85971f813785068">pwm_get_duty</a>(uint8 channel);</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__PWM__Driver__APIs.html#ga57dad644319cd4324edd382d5ce772f5">pwm_set_period</a>(uint32 period);</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;uint32 <a class="code" href="group__PWM__Driver__APIs.html#ga347173af17daf294b4312d975f3bed8b">pwm_get_period</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__PWM__Driver__APIs.html#gad405ef7080a8cea5c9ac23ba25da1fbb">pwm_start</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;}</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="structpwm__param_html_a8524d98a86c8c4679521ae91d35f6e51"><div class="ttname"><a href="structpwm__param.html#a8524d98a86c8c4679521ae91d35f6e51">pwm_param::freq</a></div><div class="ttdeci">uint32 freq</div><div class="ttdef"><b>Definition:</b> pwm.h:50</div></div>
<div class="ttc" id="structpwm__param_html_a3c1ef865ae62e58233701a3bfc68f262"><div class="ttname"><a href="structpwm__param.html#a3c1ef865ae62e58233701a3bfc68f262">pwm_param::period</a></div><div class="ttdeci">uint32 period</div><div class="ttdef"><b>Definition:</b> pwm.h:49</div></div>
<div class="ttc" id="structpwm__param_html_a06e6b4fb1983f85d1908d44cb32686a8"><div class="ttname"><a href="structpwm__param.html#a06e6b4fb1983f85d1908d44cb32686a8">pwm_param::duty</a></div><div class="ttdeci">uint32 duty[8]</div><div class="ttdef"><b>Definition:</b> pwm.h:51</div></div>
<div class="ttc" id="group__PWM__Driver__APIs_html_ga347173af17daf294b4312d975f3bed8b"><div class="ttname"><a href="group__PWM__Driver__APIs.html#ga347173af17daf294b4312d975f3bed8b">pwm_get_period</a></div><div class="ttdeci">uint32 pwm_get_period(void)</div><div class="ttdoc">Get PWM period, unit : us. </div></div>
<div class="ttc" id="group__PWM__Driver__APIs_html_ga57dad644319cd4324edd382d5ce772f5"><div class="ttname"><a href="group__PWM__Driver__APIs.html#ga57dad644319cd4324edd382d5ce772f5">pwm_set_period</a></div><div class="ttdeci">void pwm_set_period(uint32 period)</div><div class="ttdoc">Set PWM period, unit : us. </div></div>
<div class="ttc" id="group__PWM__Driver__APIs_html_ga3c85e3b8654b48f23033f132b91c07b3"><div class="ttname"><a href="group__PWM__Driver__APIs.html#ga3c85e3b8654b48f23033f132b91c07b3">pwm_set_duty</a></div><div class="ttdeci">void pwm_set_duty(uint32 duty, uint8 channel)</div><div class="ttdoc">Set the duty cycle of a PWM channel. </div></div>
<div class="ttc" id="group__PWM__Driver__APIs_html_ga96286902d138bbba183495583db6f369"><div class="ttname"><a href="group__PWM__Driver__APIs.html#ga96286902d138bbba183495583db6f369">pwm_init</a></div><div class="ttdeci">void pwm_init(uint32 period, uint32 *duty, uint32 pwm_channel_num, uint32(*pin_info_list)[3])</div><div class="ttdoc">PWM function initialization, including GPIO, frequency and duty cycle. </div></div>
<div class="ttc" id="group__PWM__Driver__APIs_html_gaa2c27474ef8774f6a85971f813785068"><div class="ttname"><a href="group__PWM__Driver__APIs.html#gaa2c27474ef8774f6a85971f813785068">pwm_get_duty</a></div><div class="ttdeci">uint32 pwm_get_duty(uint8 channel)</div><div class="ttdoc">Get the duty cycle of a PWM channel. </div></div>
<div class="ttc" id="structpwm__param_html"><div class="ttname"><a href="structpwm__param.html">pwm_param</a></div><div class="ttdef"><b>Definition:</b> pwm.h:48</div></div>
<div class="ttc" id="group__PWM__Driver__APIs_html_gad405ef7080a8cea5c9ac23ba25da1fbb"><div class="ttname"><a href="group__PWM__Driver__APIs.html#gad405ef7080a8cea5c9ac23ba25da1fbb">pwm_start</a></div><div class="ttdeci">void pwm_start(void)</div><div class="ttdoc">Starts PWM. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
